---
title: "Forge Updates JSON file"
method: GET
path: "/updates/{id|slug}/forge_updates.json"
tags: ["misc"]
---

# Forge Updates JSON file

`GET /updates/{id|slug}/forge_updates.json`

If you're a Forge mod developer, your Modrinth mods have an automatically generated `updates.json` using the
[Forge Update Checker](https://docs.minecraftforge.net/en/latest/misc/updatechecker/).

The only setup is to insert the URL into the `[[mods]]` section of your `mods.toml` file as such:

```toml
[[mods]]
# the other stuff here - ID, version, display name, etc.
updateJSONURL = "https://api.modrinth.com/updates/{slug|ID}/forge_updates.json"
```

Replace `{slug|id}` with the slug or ID of your project.

Modrinth will handle the rest! When you update your mod, Forge will notify your users that their copy of your mod is out of date.

Make sure that the version format you use for your Modrinth releases is the same as the version format you use in your `mods.toml`.
If you use a format such as `1.2.3-forge` or `1.2.3+1.19` with your Modrinth releases but your `mods.toml` only has `1.2.3`,
the update checker may not function properly.

If you're using NeoForge, NeoForge versions will, by default, not appear in the default URL.
You will need to add `?neoforge=only` to show your NeoForge-only versions, or `?neoforge=include` for both.

```toml
[[mods]]
# the other stuff here - ID, version, display name, etc.
updateJSONURL = "https://api.modrinth.com/updates/{slug|ID}/forge_updates.json?neoforge=only"
```

## Response `200`

Expected response to a valid request

- ForgeUpdates — Mod version information that can be consumed by Forge's update checker
  - `homepage` string — A link to the mod page
  - `promos` ForgeUpdateCheckerPromos — A list of the recommended and latest versions for each Minecraft release
    - `{version}-recommended` string — The mod version that is recommended for `{version}`. Excludes versions with the `alpha` and `beta` version types.
    - `{version}-latest` string — The latest mod version for `{version}`. Shows versions with the `alpha` and `beta` version types.

## Other responses

- `400` — Invalid request

---

[API](https://skmtc.net/modrinth/apis/labrinth.md) · [All operations](https://skmtc.net/modrinth/apis/labrinth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modrinth/labrinth/revisions/16bb5dbc54f4/schema)